Skip to main content

DescribeRiskWhiteList

Description

Obtain the whitelist of baseline check risk items.

Request Method

POST

Request Path

/apsara/route/aegis/DescribeRiskWhiteList

Request Parameters Common Parameters

NameLocationTypeRequiredSample valueDescription
PageSizeBODYintegerNoNo sample value for this parameter.specifies the maximum number of records per page in the returned result. default value: 20
CurrentPageBODYintegerNoNo sample value for this parameter.specifies the number of pages currently returned. default value: 1
regionIdBODYstringYesNo sample value for this parameter.region id
versionBODYstringNo2016-01-01version of api
RiskNameBODYstringNoNo sample value for this parameter.risk item name, supports fuzzy matching.

Return data

NameTypeSample valueDescription
RiskIdlongno demo valuerisk item ID.
TotalCountintegerno demo valuetotal number of records returned.
RequestIdstringno demo valuerequest ID.
PageSizeintegerno demo valuepage displays the maximum number of records.
CurrentPageintegerno demo valuecurrently returns page number.
WhiteListsarrayno demo valuewhitelist of risk items, see the following parameter description for specific sub-items.
Countintegerno demo valuenumber of current page records.
Reasonstringno demo valuethe reason for adding to the whitelist.
RiskNamestringno demo valuerisk item name.

Example

Successful Response example

{
"RiskId":"no demo value",
"TotalCount":"no demo value",
"RequestId":"no demo value",
"PageSize":"no demo value",
"CurrentPage":"no demo value",
"WhiteLists":"no demo value",
"Count":"no demo value",
"Reason":"no demo value",
"RiskName":"no demo value"
}

Failed Response example

{
"errorSample":
{
"resultCode":-1,
"resultMsg":"system error",
"result":null
}

}